Change Datasource Pause Status

Pause/UnPause usage of a datasource in the system

Method

/API3/dataSources/togglePauseDatasource

  • API Section: /API3/dataSources
  • API Version: 3.0
  • From Release: 2023.13.1
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

togglePauseDatasourceApiData

Object Type

TogglePauseDatasourceApiData

Description

The toggle object to indicate the datasource state in the system.

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Notes

This function enables or disables the use of a datasource in the system. Requires the server ID. Use 'findServerByName' to find relevant server ID

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/dataSources/togglePauseDatasource" \
 -d '{
  "isPaused" : true,
  "serverId" : "serverId"
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;

import java.util.*;
import java.time.*;

public class DataSourcesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the togglePauseDatasourceApiData parameter object for the call
        TogglePauseDatasourceApiData togglePauseDatasourceApiData = ; // Create the input object for the operation, type: TogglePauseDatasourceApiData 

        try {
            ModifiedItemsResult result = apiInstance.togglePauseDatasource(togglePauseDatasourceApiData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#togglePauseDatasource");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const togglePauseDatasourceApiData = ; // {TogglePauseDatasourceApiData} 

api.togglePauseDatasource(togglePauseDatasourceApiData).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class togglePauseDatasourceExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new DataSourcesServiceApi();
        // Initialize the togglePauseDatasourceApiData parameter object for the call
        var togglePauseDatasourceApiData = new TogglePauseDatasourceApiData(); // TogglePauseDatasourceApiData | 

        try {
            // Pause/UnPause usage of a datasource in the system
            ModifiedItemsResult result = apiInstance.togglePauseDatasource(togglePauseDatasourceApiData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.togglePauseDatasource: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = DataSourcesServiceApi(api_client)
    # Initialize the togglePauseDatasourceApiData parameter object for the call
    togglePauseDatasourceApiData =  # TogglePauseDatasourceApiData | 

    try:
        # Pause/UnPause usage of a datasource in the system
        api_response = api_instance.toggle_pause_datasource(togglePauseDatasourceApiData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->togglePauseDatasource: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$togglePauseDatasourceApiData = ; // TogglePauseDatasourceApiData | 

try {
    $result = $api_instance->togglePauseDatasource($togglePauseDatasourceApiData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourcesServiceApi->togglePauseDatasource: ', $e->getMessage(), PHP_EOL;
}
?>